test(protocol): add test cases to authenticator_test #423

deanyxu · 2025-05-09T20:49:52Z

Add test cases for AuthenticatorData's functions

Re-factor tests to also check error details
Add tests to cover failure cases
Remove newline from 2 ErrVerification to be consistent with other errors

Change-Id: Ie3459891e5ee08ceffc8d0939cbe60e2ecde3333

…errors Change-Id: I6a146c9114550fa6bad9e3376602f3fd06fa0270

coderabbitai · 2025-05-09T20:49:58Z

Walkthrough

The changes update error message formatting in the AuthenticatorData.Verify method by replacing fmt.Sprintln with fmt.Sprintf to remove unwanted trailing newlines. Additionally, the test suite for AuthenticatorData is expanded with new negative test cases, improved error assertions, and enhanced test data management for more comprehensive coverage.

Changes

File(s)	Change Summary
protocol/authenticator.go	Replaced `fmt.Sprintln` with `fmt.Sprintf` in two error messages within `AuthenticatorData.Verify` to prevent trailing newlines in error strings.
protocol/authenticator_test.go	Added new negative test cases for unmarshalling and verifying `AuthenticatorData`, introduced constants for test data, improved error validation using `assert` and `require` assertions, and expanded imports to support enhanced test logic. No changes to exported or public entity declarations.

Poem

A rabbit hopped through code today,
Cleaning up errors along the way.
With Sprintf neat, no newline mess,
And tests that check for every guess.
Now bugs are caught, and strings are clean—
The tidiest code you've ever seen!
🐇✨

Tip

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (5)

protocol/authenticator.go (2)
400-401: Avoid unnecessary fmt.Sprintf call for constant string

fmt.Sprintf is only useful when you need string interpolation.
Here we interpolate nothing, so the extra allocation is wasted.
-        return ErrVerification.WithInfo(fmt.Sprintf("User presence flag not set by authenticator"))
+        return ErrVerification.WithInfo("User presence flag not set by authenticator")
407-408: Same optimisation opportunity as above
-        return ErrVerification.WithInfo(fmt.Sprintf("User verification required but flag not set by authenticator"))
+        return ErrVerification.WithInfo("User verification required but flag not set by authenticator")
protocol/authenticator_test.go (3)
206-237: Duplicate test-case name makes failures harder to trace

Two separate scenarios are both labelled "Attested credential missing".
When a failure is reported it will be ambiguous which branch failed.
-        {
-            name:   "Attested credential missing",
+        {
+            name:   "Attested credential data flag missing",
(or pick any distinctive wording)

262-283: Consider running table-driven sub-tests in parallel

These sub-tests are independent and fairly compute-heavy (base64 decode + validation).
Adding t.Parallel() at the beginning of each t.Run body reduces overall test time without side-effects.
t.Run(tt.name, func(t *testing.T) {
    t.Parallel()          // safe: test cases share no mutable state
    a := &AuthenticatorData{ ... }
    ...
})
373-393: Same parallelisation opportunity for unmarshalAttestedData tests

For symmetry and faster CI, add t.Parallel() here as well.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5a289d5 and f0be60b.

📒 Files selected for processing (2)

protocol/authenticator.go (1 hunks)
protocol/authenticator_test.go (7 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

protocol/authenticator.go (1)

protocol/errors.go (1)

ErrVerification (63-66)

james-d-elliott

LGTM, thanks! Also for future reference I'm slowly renaming all subtests to use CamelCase and no spaces and use the name value to specify the full subtest name. This makes them easy to target withgo test.

deanyxu · 2025-05-15T22:27:23Z

LGTM, thanks! Also for future reference I'm slowly renaming all subtests to use CamelCase and no spaces and use the name value to specify the full subtest name. This makes them easy to target withgo test.

Hi @james-d-elliott, just to clarify, the plan is to rename something like

func TestAuthenticatorData_Unmarshal() to func TestAuthenticatorDataUnmarshal()
name: "None Marshall Successfully" to name: "NoneMarshallSuccessfully"?

james-d-elliott · 2025-05-15T23:21:18Z

Mostly correct. I can be very specific. I'm not very precious about this because I can just fix it later, I have a lot of tests to improve in this module.

General Rules:

Test errors against a string, testing against a var/type is optional but should not be done in place of this.

Test Function Name Format:

func Test[<struct name>_]<function name>()

Test Function Name Examples:

func TestAuthenticatorData_Unmarshal()
func TestNew

Sub-test Rules:

Sub-test name:
- CamelCase like you've noted
Sub-test struct:
- Defined as a slice var named testCases
- Use the following terms examples for appropriate field names: have, expected, err
- Ensure the field in the test case that's used to name the sub-test is named name
Sub-test loops:
- Separate to the slice of test structs

Example: https://github.com/go-webauthn/webauthn/blob/master/webauthn/login_test.go#L33-L135

deanyxu added 2 commits May 9, 2025 13:46

test(protocol): add test cases to authenticator_test

4075f96

Change-Id: Ie3459891e5ee08ceffc8d0939cbe60e2ecde3333

refactor(protocol): remove newline in some authenticator data verify …

f0be60b

…errors Change-Id: I6a146c9114550fa6bad9e3376602f3fd06fa0270

deanyxu requested a review from a team as a code owner May 9, 2025 20:49

coderabbitai bot reviewed May 9, 2025

View reviewed changes

james-d-elliott approved these changes May 10, 2025

View reviewed changes

james-d-elliott merged commit 3de0e10 into go-webauthn:master May 10, 2025
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

test(protocol): add test cases to authenticator_test #423

test(protocol): add test cases to authenticator_test #423

Uh oh!

deanyxu commented May 9, 2025

Uh oh!

coderabbitai bot commented May 9, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

james-d-elliott left a comment

Uh oh!

Uh oh!

deanyxu commented May 15, 2025

Uh oh!

james-d-elliott commented May 15, 2025

Uh oh!

Uh oh!

test(protocol): add test cases to authenticator_test #423

test(protocol): add test cases to authenticator_test #423

Uh oh!

Conversation

deanyxu commented May 9, 2025

Uh oh!

coderabbitai bot commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

james-d-elliott left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

deanyxu commented May 15, 2025

Uh oh!

james-d-elliott commented May 15, 2025

Uh oh!

Uh oh!

coderabbitai bot commented May 9, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)